Namespaces

Types in MathNet.Numerics.LinearAlgebra.Solvers

Type DelegateStopCriterion<T>

Namespace MathNet.Numerics.LinearAlgebra.Solvers

Interfaces IIterationStopCriterion<T>

Stop criterion that delegates the status determination to a delegate.

Constructors

Methods

Properties

Public Constructors

DelegateStopCriterion<T>(Func<int, Vector<T>, Vector<T>, Vector<T>, IterationStatus> determine)

Create a new instance of this criterion with a custom implementation.
Parameters
Func<int, Vector<T>, Vector<T>, Vector<T>, IterationStatus> determine

Custom implementation with the same signature and semantics as the DetermineStatus method.

Public Methods

IIterationStopCriterion<T> Clone()

Clones this criterion and its settings.

IterationStatus DetermineStatus(int iterationNumber, Vector<T> solutionVector, Vector<T> sourceVector, Vector<T> residualVector)

Determines the status of the iterative calculation by delegating it to the provided delegate. Result is set into Status field.
The individual stop criteria may internally track the progress of the calculation based on the invocation of this method. Therefore this method should only be called if the calculation has moved forwards at least one step.
Parameters
int iterationNumber

The number of iterations that have passed so far.

Vector<T> solutionVector

The vector containing the current solution values.

Vector<T> sourceVector

The right hand side vector.

Vector<T> residualVector

The vector containing the current residual vectors.

bool Equals(object obj)

int GetHashCode()

Type GetType()

void Reset()

Resets the IIterationStopCriterion to the pre-calculation state.

string ToString()

Public Properties

IterationStatus Status get;

Gets the current calculation status.